<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.function.impl;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.ArrayList;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.List;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Map;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.TreeMap;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    import org.hackystat.telemetry.analyzer.function.TelemetryFunction;<a name="line.8"></a>
<FONT color="green">009</FONT>    import org.hackystat.telemetry.analyzer.function.TelemetryFunctionException;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.hackystat.telemetry.analyzer.model.TelemetryDataPoint;<a name="line.10"></a>
<FONT color="green">011</FONT>    import org.hackystat.telemetry.analyzer.model.TelemetryStream;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.hackystat.telemetry.analyzer.model.TelemetryStreamCollection;<a name="line.12"></a>
<FONT color="green">013</FONT>    <a name="line.13"></a>
<FONT color="green">014</FONT>    /**<a name="line.14"></a>
<FONT color="green">015</FONT>     * Filters telemetry streams in a &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; object by applying a <a name="line.15"></a>
<FONT color="green">016</FONT>     * ranking function.<a name="line.16"></a>
<FONT color="green">017</FONT>     * <a name="line.17"></a>
<FONT color="green">018</FONT>     * @author (Cedric) Qin ZHANG<a name="line.18"></a>
<FONT color="green">019</FONT>     */<a name="line.19"></a>
<FONT color="green">020</FONT>    public class FilterFunction extends TelemetryFunction {<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>      private static Map&lt;String, RankFunction&gt; RANK_FUNCTIONS = new TreeMap&lt;String, RankFunction&gt;();<a name="line.22"></a>
<FONT color="green">023</FONT>      <a name="line.23"></a>
<FONT color="green">024</FONT>      /**<a name="line.24"></a>
<FONT color="green">025</FONT>       * Constructs this instance.<a name="line.25"></a>
<FONT color="green">026</FONT>       * <a name="line.26"></a>
<FONT color="green">027</FONT>       */<a name="line.27"></a>
<FONT color="green">028</FONT>      public FilterFunction() {<a name="line.28"></a>
<FONT color="green">029</FONT>        super("Filter");<a name="line.29"></a>
<FONT color="green">030</FONT>        RANK_FUNCTIONS.put("avg", new AverageRankFunction());<a name="line.30"></a>
<FONT color="green">031</FONT>        RANK_FUNCTIONS.put("max", new MaxRankFunction());<a name="line.31"></a>
<FONT color="green">032</FONT>        RANK_FUNCTIONS.put("min", new MinRankFunction());<a name="line.32"></a>
<FONT color="green">033</FONT>        RANK_FUNCTIONS.put("last", new LastRankFunction());<a name="line.33"></a>
<FONT color="green">034</FONT>        RANK_FUNCTIONS.put("delta", new DeltaRankFunction());<a name="line.34"></a>
<FONT color="green">035</FONT>        RANK_FUNCTIONS.put("simpledelta", new SimpleDeltaRankFunction());<a name="line.35"></a>
<FONT color="green">036</FONT>      }<a name="line.36"></a>
<FONT color="green">037</FONT>      <a name="line.37"></a>
<FONT color="green">038</FONT>      /**<a name="line.38"></a>
<FONT color="green">039</FONT>       * Performs filter operation. The returned &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; only contains<a name="line.39"></a>
<FONT color="green">040</FONT>       * telemetry streams that satisfies the specified criteria.<a name="line.40"></a>
<FONT color="green">041</FONT>       * <a name="line.41"></a>
<FONT color="green">042</FONT>       * @param parameters An array of 3 objects.<a name="line.42"></a>
<FONT color="green">043</FONT>       *        &lt;ul&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>       *          &lt;li&gt;1st element: A &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; instance.<a name="line.44"></a>
<FONT color="green">045</FONT>       *          &lt;li&gt;2nd element: A &lt;code&gt;String&lt;/code&gt; representing ranking function name.<a name="line.45"></a>
<FONT color="green">046</FONT>       *              It must be one of "Sum|Max|Min|Last|Delta".<a name="line.46"></a>
<FONT color="green">047</FONT>       *          &lt;li&gt;3rd element: A &lt;code&gt;String&lt;/code&gt; specifying how to apply cutoff value.<a name="line.47"></a>
<FONT color="green">048</FONT>       *              It must be one of "Above|Below|Top|Bottom|TopPercent|BottomPercent".<a name="line.48"></a>
<FONT color="green">049</FONT>       *          &lt;li&gt;4th element: A &lt;code&gt;Number&lt;/code&gt; instance representing cutoff value.<a name="line.49"></a>
<FONT color="green">050</FONT>       *        &lt;/ul&gt; <a name="line.50"></a>
<FONT color="green">051</FONT>       * <a name="line.51"></a>
<FONT color="green">052</FONT>       * @return A new &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; instance after filtering. Note<a name="line.52"></a>
<FONT color="green">053</FONT>       *         that it may contain no telemetry stream at all if no stream satisfies the criteria.<a name="line.53"></a>
<FONT color="green">054</FONT>       * <a name="line.54"></a>
<FONT color="green">055</FONT>       * @throws TelemetryFunctionException If anything is wrong.<a name="line.55"></a>
<FONT color="green">056</FONT>       */<a name="line.56"></a>
<FONT color="green">057</FONT>      @Override<a name="line.57"></a>
<FONT color="green">058</FONT>      public Object compute(Object[] parameters) throws TelemetryFunctionException {<a name="line.58"></a>
<FONT color="green">059</FONT>        if (parameters.length != 4 || ! (parameters[0] instanceof TelemetryStreamCollection)<a name="line.59"></a>
<FONT color="green">060</FONT>             || ! (parameters[1] instanceof String) || ! (parameters[2] instanceof String)<a name="line.60"></a>
<FONT color="green">061</FONT>             || ! (parameters[3] instanceof Number || parameters[3] instanceof String)) {<a name="line.61"></a>
<FONT color="green">062</FONT>           throw new TelemetryFunctionException("Telemetry function " + this.getName()<a name="line.62"></a>
<FONT color="green">063</FONT>             + " accept 4 parameters: TelemetryStreamCollection, Avg|Max|Min|Last|Delta|SimpleDelta,"<a name="line.63"></a>
<FONT color="green">064</FONT>             + " Above|Below|Top|Bottom|TopPercent|BottomPercent, Number.");<a name="line.64"></a>
<FONT color="green">065</FONT>        }<a name="line.65"></a>
<FONT color="green">066</FONT>        <a name="line.66"></a>
<FONT color="green">067</FONT>        if (parameters[3] instanceof String) {<a name="line.67"></a>
<FONT color="green">068</FONT>          try {<a name="line.68"></a>
<FONT color="green">069</FONT>            parameters[3] = new Double((String) parameters[3]);<a name="line.69"></a>
<FONT color="green">070</FONT>          }<a name="line.70"></a>
<FONT color="green">071</FONT>          catch (NumberFormatException ex) {<a name="line.71"></a>
<FONT color="green">072</FONT>            throw new TelemetryFunctionException("The 4th parameter of telemetry function " <a name="line.72"></a>
<FONT color="green">073</FONT>                + this.getName() + " is not a valid number.", ex);     <a name="line.73"></a>
<FONT color="green">074</FONT>          }<a name="line.74"></a>
<FONT color="green">075</FONT>        }<a name="line.75"></a>
<FONT color="green">076</FONT>          <a name="line.76"></a>
<FONT color="green">077</FONT>        TelemetryStreamCollection streams = (TelemetryStreamCollection) parameters[0];<a name="line.77"></a>
<FONT color="green">078</FONT>         <a name="line.78"></a>
<FONT color="green">079</FONT>        String rankFunctionName = (String) parameters[1];<a name="line.79"></a>
<FONT color="green">080</FONT>        RankFunction rankFunction = RANK_FUNCTIONS.get(rankFunctionName.toLowerCase());<a name="line.80"></a>
<FONT color="green">081</FONT>        if (rankFunction == null) {<a name="line.81"></a>
<FONT color="green">082</FONT>          throw new TelemetryFunctionException("Rank function '" + rankFunctionName <a name="line.82"></a>
<FONT color="green">083</FONT>              + "' does not exist.");<a name="line.83"></a>
<FONT color="green">084</FONT>        }<a name="line.84"></a>
<FONT color="green">085</FONT>         <a name="line.85"></a>
<FONT color="green">086</FONT>        String opMode = (String) parameters[2];<a name="line.86"></a>
<FONT color="green">087</FONT>        Number cutoff = (Number) parameters[3];<a name="line.87"></a>
<FONT color="green">088</FONT>       <a name="line.88"></a>
<FONT color="green">089</FONT>        try {<a name="line.89"></a>
<FONT color="green">090</FONT>          if ("Above".equalsIgnoreCase(opMode)) {<a name="line.90"></a>
<FONT color="green">091</FONT>            return this.applyAbsoluteCutoff(streams, rankFunction, true, cutoff.doubleValue());<a name="line.91"></a>
<FONT color="green">092</FONT>          }<a name="line.92"></a>
<FONT color="green">093</FONT>          else if ("Below".equals(opMode)) {<a name="line.93"></a>
<FONT color="green">094</FONT>            return this.applyAbsoluteCutoff(streams, rankFunction, false, cutoff.doubleValue());<a name="line.94"></a>
<FONT color="green">095</FONT>          }<a name="line.95"></a>
<FONT color="green">096</FONT>          else if ("TopPercent".equalsIgnoreCase(opMode) || "BottomPercent".equalsIgnoreCase(opMode)<a name="line.96"></a>
<FONT color="green">097</FONT>              || "Top".equalsIgnoreCase(opMode) || "Bottom".equalsIgnoreCase(opMode)) {<a name="line.97"></a>
<FONT color="green">098</FONT>            return this.applyRelativeCutoff(streams, rankFunction, opMode, cutoff.intValue());<a name="line.98"></a>
<FONT color="green">099</FONT>          }<a name="line.99"></a>
<FONT color="green">100</FONT>          else {<a name="line.100"></a>
<FONT color="green">101</FONT>            throw new TelemetryFunctionException("The 3rd parameter of telemetry function " <a name="line.101"></a>
<FONT color="green">102</FONT>                + this.getName() + " must be one of Above|Below|TopPercent|BottomPercent|Top|Bottom.");<a name="line.102"></a>
<FONT color="green">103</FONT>            }<a name="line.103"></a>
<FONT color="green">104</FONT>        }<a name="line.104"></a>
<FONT color="green">105</FONT>        catch (Exception ex) {<a name="line.105"></a>
<FONT color="green">106</FONT>          throw new TelemetryFunctionException(ex);<a name="line.106"></a>
<FONT color="green">107</FONT>        }<a name="line.107"></a>
<FONT color="green">108</FONT>      }<a name="line.108"></a>
<FONT color="green">109</FONT>      <a name="line.109"></a>
<FONT color="green">110</FONT>      /**<a name="line.110"></a>
<FONT color="green">111</FONT>       * Applies filter and returns only the telemetry streams meeting the criteria.<a name="line.111"></a>
<FONT color="green">112</FONT>       * <a name="line.112"></a>
<FONT color="green">113</FONT>       * @param streams Telemetry stream collection.<a name="line.113"></a>
<FONT color="green">114</FONT>       * @param rankFunction The rank function.<a name="line.114"></a>
<FONT color="green">115</FONT>       * @param isAbove True if the filter is to return the streams above the cutoff value.<a name="line.115"></a>
<FONT color="green">116</FONT>       *                False if the filter is to return the streams below the cutoff value.<a name="line.116"></a>
<FONT color="green">117</FONT>       * @param cutoff The cutoff value.<a name="line.117"></a>
<FONT color="green">118</FONT>       * <a name="line.118"></a>
<FONT color="green">119</FONT>       * @return A new &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; instance after filtering. <a name="line.119"></a>
<FONT color="green">120</FONT>       * @throws Exception If there is anything wrong.<a name="line.120"></a>
<FONT color="green">121</FONT>       */<a name="line.121"></a>
<FONT color="green">122</FONT>      private TelemetryStreamCollection applyAbsoluteCutoff(TelemetryStreamCollection streams,<a name="line.122"></a>
<FONT color="green">123</FONT>          RankFunction rankFunction, boolean isAbove, double cutoff) throws Exception {<a name="line.123"></a>
<FONT color="green">124</FONT>        <a name="line.124"></a>
<FONT color="green">125</FONT>        TelemetryStreamCollection target = new TelemetryStreamCollection(<a name="line.125"></a>
<FONT color="green">126</FONT>            streams.getName(), streams.getProject(), streams.getInterval());   <a name="line.126"></a>
<FONT color="green">127</FONT>        for (TelemetryStream stream : streams) {<a name="line.127"></a>
<FONT color="green">128</FONT>          double rank = rankFunction.getRank(stream);<a name="line.128"></a>
<FONT color="green">129</FONT>          if ((isAbove &amp;&amp; rank &gt; cutoff) || (! isAbove &amp;&amp; rank &lt; cutoff)) {<a name="line.129"></a>
<FONT color="green">130</FONT>            target.add(stream);<a name="line.130"></a>
<FONT color="green">131</FONT>          }<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>        return target;<a name="line.133"></a>
<FONT color="green">134</FONT>      }<a name="line.134"></a>
<FONT color="green">135</FONT>      <a name="line.135"></a>
<FONT color="green">136</FONT>      /**<a name="line.136"></a>
<FONT color="green">137</FONT>       * Applies filter and returns the telemetry streams at the top or bottom.<a name="line.137"></a>
<FONT color="green">138</FONT>       * <a name="line.138"></a>
<FONT color="green">139</FONT>       * @param streams Telemetry stream collection.<a name="line.139"></a>
<FONT color="green">140</FONT>       * @param rankFunction The rank function.<a name="line.140"></a>
<FONT color="green">141</FONT>       * @param opMode Operation mode.<a name="line.141"></a>
<FONT color="green">142</FONT>       * @param cutoff The cutoff value.<a name="line.142"></a>
<FONT color="green">143</FONT>       * <a name="line.143"></a>
<FONT color="green">144</FONT>       * @return A new &lt;code&gt;TelemetryStreamCollection&lt;/code&gt; instance after filtering. <a name="line.144"></a>
<FONT color="green">145</FONT>       * @throws Exception If there is anything wrong.<a name="line.145"></a>
<FONT color="green">146</FONT>       */<a name="line.146"></a>
<FONT color="green">147</FONT>      @SuppressWarnings("cast")<a name="line.147"></a>
<FONT color="green">148</FONT>      private TelemetryStreamCollection applyRelativeCutoff(TelemetryStreamCollection streams, <a name="line.148"></a>
<FONT color="green">149</FONT>          RankFunction rankFunction, String opMode, int cutoff) throws Exception {<a name="line.149"></a>
<FONT color="green">150</FONT>        <a name="line.150"></a>
<FONT color="green">151</FONT>        TelemetryStreamCollection target = new TelemetryStreamCollection(<a name="line.151"></a>
<FONT color="green">152</FONT>            streams.getName(), streams.getProject(), streams.getInterval());<a name="line.152"></a>
<FONT color="green">153</FONT>        ArrayList&lt;TelemetryStream&gt; orderedList = this.sort(rankFunction, streams);<a name="line.153"></a>
<FONT color="green">154</FONT>        <a name="line.154"></a>
<FONT color="green">155</FONT>        if ("TopPercent".equalsIgnoreCase(opMode)) {<a name="line.155"></a>
<FONT color="green">156</FONT>          if (cutoff &lt; 0 || cutoff &gt; 100) {<a name="line.156"></a>
<FONT color="green">157</FONT>            throw new TelemetryFunctionException("You must supply a cutoff value from 0 to 100 for " +<a name="line.157"></a>
<FONT color="green">158</FONT>                "'TopPercent' operation mode.");<a name="line.158"></a>
<FONT color="green">159</FONT>          }<a name="line.159"></a>
<FONT color="green">160</FONT>          int start = (int) Math.floor(<a name="line.160"></a>
<FONT color="green">161</FONT>              (double) orderedList.size() - (double) orderedList.size() * cutoff / 100);<a name="line.161"></a>
<FONT color="green">162</FONT>          if (start &lt; 0) {<a name="line.162"></a>
<FONT color="green">163</FONT>            start = 0;<a name="line.163"></a>
<FONT color="green">164</FONT>          }<a name="line.164"></a>
<FONT color="green">165</FONT>          for (int i = start; i &lt; orderedList.size(); i++) {<a name="line.165"></a>
<FONT color="green">166</FONT>            target.add(orderedList.get(i));<a name="line.166"></a>
<FONT color="green">167</FONT>          }<a name="line.167"></a>
<FONT color="green">168</FONT>        }<a name="line.168"></a>
<FONT color="green">169</FONT>        else if ("BottomPercent".equalsIgnoreCase(opMode)) {<a name="line.169"></a>
<FONT color="green">170</FONT>          if (cutoff &lt; 0 || cutoff &gt; 100) {<a name="line.170"></a>
<FONT color="green">171</FONT>            throw new TelemetryFunctionException("You must supply a cutoff value from 0 to 100 for " +<a name="line.171"></a>
<FONT color="green">172</FONT>                "'BottomPercent' operation mode.");<a name="line.172"></a>
<FONT color="green">173</FONT>          }<a name="line.173"></a>
<FONT color="green">174</FONT>          int count = (int) Math.ceil((double) orderedList.size() * cutoff / 100);<a name="line.174"></a>
<FONT color="green">175</FONT>          for (int i = 0; i &lt; count &amp;&amp; i &lt; orderedList.size(); i++) {<a name="line.175"></a>
<FONT color="green">176</FONT>            target.add(orderedList.get(i));<a name="line.176"></a>
<FONT color="green">177</FONT>          }<a name="line.177"></a>
<FONT color="green">178</FONT>        }<a name="line.178"></a>
<FONT color="green">179</FONT>        else if ("Top".equalsIgnoreCase(opMode)) {<a name="line.179"></a>
<FONT color="green">180</FONT>          int start = orderedList.size() - cutoff;<a name="line.180"></a>
<FONT color="green">181</FONT>          if (start &lt; 0) {<a name="line.181"></a>
<FONT color="green">182</FONT>            start = 0;<a name="line.182"></a>
<FONT color="green">183</FONT>          }<a name="line.183"></a>
<FONT color="green">184</FONT>          for (int i = start; i &lt; orderedList.size(); i++) {<a name="line.184"></a>
<FONT color="green">185</FONT>            target.add(orderedList.get(i));<a name="line.185"></a>
<FONT color="green">186</FONT>          }<a name="line.186"></a>
<FONT color="green">187</FONT>        }<a name="line.187"></a>
<FONT color="green">188</FONT>        else if ("Bottom".equalsIgnoreCase(opMode)) {<a name="line.188"></a>
<FONT color="green">189</FONT>          for (int i = 0; i &lt; cutoff &amp;&amp; i &lt; orderedList.size(); i++) {<a name="line.189"></a>
<FONT color="green">190</FONT>            target.add(orderedList.get(i));<a name="line.190"></a>
<FONT color="green">191</FONT>          }<a name="line.191"></a>
<FONT color="green">192</FONT>        }<a name="line.192"></a>
<FONT color="green">193</FONT>        else {<a name="line.193"></a>
<FONT color="green">194</FONT>          throw new TelemetryFunctionException("Unsupported op mode '" + opMode + "'.");<a name="line.194"></a>
<FONT color="green">195</FONT>        }<a name="line.195"></a>
<FONT color="green">196</FONT>        <a name="line.196"></a>
<FONT color="green">197</FONT>        return target;<a name="line.197"></a>
<FONT color="green">198</FONT>      }<a name="line.198"></a>
<FONT color="green">199</FONT>      <a name="line.199"></a>
<FONT color="green">200</FONT>      /**<a name="line.200"></a>
<FONT color="green">201</FONT>       * Sorts the telemetry streams according to a rank function.<a name="line.201"></a>
<FONT color="green">202</FONT>       * <a name="line.202"></a>
<FONT color="green">203</FONT>       * @param rankFunction The rank function.<a name="line.203"></a>
<FONT color="green">204</FONT>       * @param streams Telemetry stream collection.<a name="line.204"></a>
<FONT color="green">205</FONT>       * <a name="line.205"></a>
<FONT color="green">206</FONT>       * @return A sorted list of telemetry streams, from the smallest rank value to the largest.<a name="line.206"></a>
<FONT color="green">207</FONT>       * <a name="line.207"></a>
<FONT color="green">208</FONT>       * @throws TelemetryFunctionException If the rank function does not exist.<a name="line.208"></a>
<FONT color="green">209</FONT>       */<a name="line.209"></a>
<FONT color="green">210</FONT>      private ArrayList&lt;TelemetryStream&gt; sort(RankFunction rankFunction, <a name="line.210"></a>
<FONT color="green">211</FONT>          TelemetryStreamCollection streams) <a name="line.211"></a>
<FONT color="green">212</FONT>          throws TelemetryFunctionException {<a name="line.212"></a>
<FONT color="green">213</FONT>    <a name="line.213"></a>
<FONT color="green">214</FONT>        TreeMap&lt;Double, List&lt;TelemetryStream&gt;&gt; map = new TreeMap&lt;Double, List&lt;TelemetryStream&gt;&gt;();<a name="line.214"></a>
<FONT color="green">215</FONT>        for (TelemetryStream stream : streams.getTelemetryStreams()) {<a name="line.215"></a>
<FONT color="green">216</FONT>          Double rank = new Double(rankFunction.getRank(stream));<a name="line.216"></a>
<FONT color="green">217</FONT>          List&lt;TelemetryStream&gt; list = map.get(rank);<a name="line.217"></a>
<FONT color="green">218</FONT>          if (list == null) {<a name="line.218"></a>
<FONT color="green">219</FONT>            list = new ArrayList&lt;TelemetryStream&gt;(1);<a name="line.219"></a>
<FONT color="green">220</FONT>            map.put(rank, list);<a name="line.220"></a>
<FONT color="green">221</FONT>          }<a name="line.221"></a>
<FONT color="green">222</FONT>          list.add(stream);<a name="line.222"></a>
<FONT color="green">223</FONT>        }<a name="line.223"></a>
<FONT color="green">224</FONT>        <a name="line.224"></a>
<FONT color="green">225</FONT>        ArrayList&lt;TelemetryStream&gt; sortedList = <a name="line.225"></a>
<FONT color="green">226</FONT>          new ArrayList&lt;TelemetryStream&gt;(streams.getTelemetryStreams().size());<a name="line.226"></a>
<FONT color="green">227</FONT>        for (List&lt;TelemetryStream&gt; list : map.values()) {<a name="line.227"></a>
<FONT color="green">228</FONT>          sortedList.addAll(list);<a name="line.228"></a>
<FONT color="green">229</FONT>        }<a name="line.229"></a>
<FONT color="green">230</FONT>        return sortedList;<a name="line.230"></a>
<FONT color="green">231</FONT>      }<a name="line.231"></a>
<FONT color="green">232</FONT>      <a name="line.232"></a>
<FONT color="green">233</FONT>      //===================== Rank Function ==============================<a name="line.233"></a>
<FONT color="green">234</FONT>      <a name="line.234"></a>
<FONT color="green">235</FONT>      /**<a name="line.235"></a>
<FONT color="green">236</FONT>       * Rank function.<a name="line.236"></a>
<FONT color="green">237</FONT>       */<a name="line.237"></a>
<FONT color="green">238</FONT>      interface RankFunction {<a name="line.238"></a>
<FONT color="green">239</FONT>        <a name="line.239"></a>
<FONT color="green">240</FONT>        /**<a name="line.240"></a>
<FONT color="green">241</FONT>         * Gets a rank value for a telemetry stream. Note that any implmentation MUST observe the<a name="line.241"></a>
<FONT color="green">242</FONT>         * rules: The function should never return Double.POSITIVE_INFINITY, <a name="line.242"></a>
<FONT color="green">243</FONT>         *       Double.NEGATIVE_INFINITY, or Double.NaN.<a name="line.243"></a>
<FONT color="green">244</FONT>         *<a name="line.244"></a>
<FONT color="green">245</FONT>         * @param stream A telemetry stream.<a name="line.245"></a>
<FONT color="green">246</FONT>         * @return A rank value.<a name="line.246"></a>
<FONT color="green">247</FONT>         */<a name="line.247"></a>
<FONT color="green">248</FONT>        double getRank(TelemetryStream stream);<a name="line.248"></a>
<FONT color="green">249</FONT>      }<a name="line.249"></a>
<FONT color="green">250</FONT>      <a name="line.250"></a>
<FONT color="green">251</FONT>      //NOTE: Sum function is bad, it ignores the data points with no value, which makes the sum<a name="line.251"></a>
<FONT color="green">252</FONT>      //      of different telemetry streams not comparable if there is a missing point.<a name="line.252"></a>
<FONT color="green">253</FONT>      //      There is no easy way around this. Use Average instead.<a name="line.253"></a>
<FONT color="green">254</FONT>      <a name="line.254"></a>
<FONT color="green">255</FONT>    //  /**<a name="line.255"></a>
<FONT color="green">256</FONT>    //   * A rank function using sum as ranking criteria.<a name="line.256"></a>
<FONT color="green">257</FONT>    //   * <a name="line.257"></a>
<FONT color="green">258</FONT>    //   * @author (Cedric) Qin ZHANG<a name="line.258"></a>
<FONT color="green">259</FONT>    //   * @version $Id$<a name="line.259"></a>
<FONT color="green">260</FONT>    //   */<a name="line.260"></a>
<FONT color="green">261</FONT>    //  static class SumRankFunction implements RankFunction {<a name="line.261"></a>
<FONT color="green">262</FONT>    //    <a name="line.262"></a>
<FONT color="green">263</FONT>    //    /**<a name="line.263"></a>
<FONT color="green">264</FONT>    //     * Computes the sum of a telemetry stream.<a name="line.264"></a>
<FONT color="green">265</FONT>    //     * @param stream A telemetry stream.<a name="line.265"></a>
<FONT color="green">266</FONT>    //     * @return The sum.<a name="line.266"></a>
<FONT color="green">267</FONT>    //     */<a name="line.267"></a>
<FONT color="green">268</FONT>    //    public double getRank(TelemetryStream stream) {<a name="line.268"></a>
<FONT color="green">269</FONT>    //      double sum = 0;<a name="line.269"></a>
<FONT color="green">270</FONT>    //      for (Iterator i = stream.getDataPoints().iterator(); i.hasNext(); ) {<a name="line.270"></a>
<FONT color="green">271</FONT>    //        TelemetryDataPoint dp = (TelemetryDataPoint) i.next();<a name="line.271"></a>
<FONT color="green">272</FONT>    //        Number number = dp.getValue();<a name="line.272"></a>
<FONT color="green">273</FONT>    //        if (number != null) {<a name="line.273"></a>
<FONT color="green">274</FONT>    //          double numberValue = number.doubleValue();<a name="line.274"></a>
<FONT color="green">275</FONT>    //          if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.275"></a>
<FONT color="green">276</FONT>    //            //Cannot use infinity, because Positive infinity + negative infinity = NaN<a name="line.276"></a>
<FONT color="green">277</FONT>    //            sum += numberValue;<a name="line.277"></a>
<FONT color="green">278</FONT>    //          }<a name="line.278"></a>
<FONT color="green">279</FONT>    //        }<a name="line.279"></a>
<FONT color="green">280</FONT>    //      }<a name="line.280"></a>
<FONT color="green">281</FONT>    //      return sum;<a name="line.281"></a>
<FONT color="green">282</FONT>    //    }<a name="line.282"></a>
<FONT color="green">283</FONT>    //  }<a name="line.283"></a>
<FONT color="green">284</FONT>      <a name="line.284"></a>
<FONT color="green">285</FONT>      /**<a name="line.285"></a>
<FONT color="green">286</FONT>       * A rank function using average as ranking criteria.<a name="line.286"></a>
<FONT color="green">287</FONT>       * <a name="line.287"></a>
<FONT color="green">288</FONT>       * @author (Cedric) Qin ZHANG<a name="line.288"></a>
<FONT color="green">289</FONT>       */<a name="line.289"></a>
<FONT color="green">290</FONT>      static class AverageRankFunction implements RankFunction {<a name="line.290"></a>
<FONT color="green">291</FONT>        <a name="line.291"></a>
<FONT color="green">292</FONT>        /**<a name="line.292"></a>
<FONT color="green">293</FONT>         * Computes the average of a telemetry stream.<a name="line.293"></a>
<FONT color="green">294</FONT>         * @param stream A telemetry stream.<a name="line.294"></a>
<FONT color="green">295</FONT>         * @return The average.<a name="line.295"></a>
<FONT color="green">296</FONT>         */<a name="line.296"></a>
<FONT color="green">297</FONT>        public double getRank(TelemetryStream stream) {<a name="line.297"></a>
<FONT color="green">298</FONT>          int count = 0;<a name="line.298"></a>
<FONT color="green">299</FONT>          double sum = 0;<a name="line.299"></a>
<FONT color="green">300</FONT>          for (TelemetryDataPoint dp : stream.getDataPoints()) {<a name="line.300"></a>
<FONT color="green">301</FONT>            Number number = dp.getValue();<a name="line.301"></a>
<FONT color="green">302</FONT>            if (number != null) {<a name="line.302"></a>
<FONT color="green">303</FONT>              double numberValue = number.doubleValue();<a name="line.303"></a>
<FONT color="green">304</FONT>              if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.304"></a>
<FONT color="green">305</FONT>                //Cannot use infinity, because Positive infinity + negative infinity = NaN<a name="line.305"></a>
<FONT color="green">306</FONT>                count ++;<a name="line.306"></a>
<FONT color="green">307</FONT>                sum += numberValue;<a name="line.307"></a>
<FONT color="green">308</FONT>              }<a name="line.308"></a>
<FONT color="green">309</FONT>            }<a name="line.309"></a>
<FONT color="green">310</FONT>          }<a name="line.310"></a>
<FONT color="green">311</FONT>          return count == 0 ? 0 : sum / count;<a name="line.311"></a>
<FONT color="green">312</FONT>        }<a name="line.312"></a>
<FONT color="green">313</FONT>      }<a name="line.313"></a>
<FONT color="green">314</FONT>      <a name="line.314"></a>
<FONT color="green">315</FONT>      /**<a name="line.315"></a>
<FONT color="green">316</FONT>       * A rank function using max as ranking criteria.<a name="line.316"></a>
<FONT color="green">317</FONT>       * <a name="line.317"></a>
<FONT color="green">318</FONT>       * @author (Cedric) Qin ZHANG<a name="line.318"></a>
<FONT color="green">319</FONT>       */<a name="line.319"></a>
<FONT color="green">320</FONT>      static class MaxRankFunction implements RankFunction {<a name="line.320"></a>
<FONT color="green">321</FONT>        <a name="line.321"></a>
<FONT color="green">322</FONT>        /**<a name="line.322"></a>
<FONT color="green">323</FONT>         * Computes the max value of a telemetry stream.<a name="line.323"></a>
<FONT color="green">324</FONT>         * @param stream A telemetry stream.<a name="line.324"></a>
<FONT color="green">325</FONT>         * @return The max value.<a name="line.325"></a>
<FONT color="green">326</FONT>         */<a name="line.326"></a>
<FONT color="green">327</FONT>        public double getRank(TelemetryStream stream) {<a name="line.327"></a>
<FONT color="green">328</FONT>          double max = Double.MIN_VALUE;<a name="line.328"></a>
<FONT color="green">329</FONT>          for (TelemetryDataPoint dp : stream.getDataPoints()) {<a name="line.329"></a>
<FONT color="green">330</FONT>            Number number = dp.getValue();<a name="line.330"></a>
<FONT color="green">331</FONT>            if (number != null) {<a name="line.331"></a>
<FONT color="green">332</FONT>              double numberValue = number.doubleValue();<a name="line.332"></a>
<FONT color="green">333</FONT>              if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.333"></a>
<FONT color="green">334</FONT>                if (max &lt; numberValue) { //NOPMD<a name="line.334"></a>
<FONT color="green">335</FONT>                  max = numberValue;<a name="line.335"></a>
<FONT color="green">336</FONT>                }<a name="line.336"></a>
<FONT color="green">337</FONT>              }<a name="line.337"></a>
<FONT color="green">338</FONT>            }<a name="line.338"></a>
<FONT color="green">339</FONT>          }<a name="line.339"></a>
<FONT color="green">340</FONT>          return max;<a name="line.340"></a>
<FONT color="green">341</FONT>        }<a name="line.341"></a>
<FONT color="green">342</FONT>      }<a name="line.342"></a>
<FONT color="green">343</FONT>      <a name="line.343"></a>
<FONT color="green">344</FONT>      /**<a name="line.344"></a>
<FONT color="green">345</FONT>       * A rank function using min as ranking criteria.<a name="line.345"></a>
<FONT color="green">346</FONT>       * <a name="line.346"></a>
<FONT color="green">347</FONT>       * @author (Cedric) Qin ZHANG<a name="line.347"></a>
<FONT color="green">348</FONT>       */<a name="line.348"></a>
<FONT color="green">349</FONT>      static class MinRankFunction implements RankFunction {<a name="line.349"></a>
<FONT color="green">350</FONT>        <a name="line.350"></a>
<FONT color="green">351</FONT>        /**<a name="line.351"></a>
<FONT color="green">352</FONT>         * Computes the min value of a telemetry stream.<a name="line.352"></a>
<FONT color="green">353</FONT>         * @param stream A telemetry stream.<a name="line.353"></a>
<FONT color="green">354</FONT>         * @return The min value.<a name="line.354"></a>
<FONT color="green">355</FONT>         */<a name="line.355"></a>
<FONT color="green">356</FONT>        public double getRank(TelemetryStream stream) {<a name="line.356"></a>
<FONT color="green">357</FONT>          double min = Double.MAX_VALUE;<a name="line.357"></a>
<FONT color="green">358</FONT>          for (TelemetryDataPoint dp : stream.getDataPoints()) {<a name="line.358"></a>
<FONT color="green">359</FONT>            Number number = dp.getValue();<a name="line.359"></a>
<FONT color="green">360</FONT>            if (number != null) {<a name="line.360"></a>
<FONT color="green">361</FONT>              double numberValue = number.doubleValue();<a name="line.361"></a>
<FONT color="green">362</FONT>              if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.362"></a>
<FONT color="green">363</FONT>                if (min &gt; numberValue) { //NOPMD<a name="line.363"></a>
<FONT color="green">364</FONT>                  min = numberValue;<a name="line.364"></a>
<FONT color="green">365</FONT>                }<a name="line.365"></a>
<FONT color="green">366</FONT>              }<a name="line.366"></a>
<FONT color="green">367</FONT>            }<a name="line.367"></a>
<FONT color="green">368</FONT>          }<a name="line.368"></a>
<FONT color="green">369</FONT>          return min;<a name="line.369"></a>
<FONT color="green">370</FONT>        }<a name="line.370"></a>
<FONT color="green">371</FONT>      }<a name="line.371"></a>
<FONT color="green">372</FONT>      <a name="line.372"></a>
<FONT color="green">373</FONT>      /**<a name="line.373"></a>
<FONT color="green">374</FONT>       * A rank function using the lastest data point value as ranking criteria.<a name="line.374"></a>
<FONT color="green">375</FONT>       * <a name="line.375"></a>
<FONT color="green">376</FONT>       * @author (Cedric) Qin ZHANG<a name="line.376"></a>
<FONT color="green">377</FONT>       */<a name="line.377"></a>
<FONT color="green">378</FONT>      static class LastRankFunction implements RankFunction {<a name="line.378"></a>
<FONT color="green">379</FONT>        <a name="line.379"></a>
<FONT color="green">380</FONT>        /**<a name="line.380"></a>
<FONT color="green">381</FONT>         * Computes the last value of a telemetry stream.<a name="line.381"></a>
<FONT color="green">382</FONT>         * @param stream A telemetry stream.<a name="line.382"></a>
<FONT color="green">383</FONT>         * @return The last value.<a name="line.383"></a>
<FONT color="green">384</FONT>         */<a name="line.384"></a>
<FONT color="green">385</FONT>        public double getRank(TelemetryStream stream) {<a name="line.385"></a>
<FONT color="green">386</FONT>          List&lt;TelemetryDataPoint&gt; list = stream.getDataPoints();<a name="line.386"></a>
<FONT color="green">387</FONT>          for (int i = list.size() - 1; i &gt;= 0; i--) {<a name="line.387"></a>
<FONT color="green">388</FONT>            TelemetryDataPoint dp = list.get(i);<a name="line.388"></a>
<FONT color="green">389</FONT>            Number number = dp.getValue();<a name="line.389"></a>
<FONT color="green">390</FONT>            if (number != null) {<a name="line.390"></a>
<FONT color="green">391</FONT>              double numberValue = number.doubleValue();<a name="line.391"></a>
<FONT color="green">392</FONT>              if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.392"></a>
<FONT color="green">393</FONT>                return numberValue;<a name="line.393"></a>
<FONT color="green">394</FONT>              }<a name="line.394"></a>
<FONT color="green">395</FONT>            }<a name="line.395"></a>
<FONT color="green">396</FONT>          }<a name="line.396"></a>
<FONT color="green">397</FONT>          return 0;<a name="line.397"></a>
<FONT color="green">398</FONT>        }<a name="line.398"></a>
<FONT color="green">399</FONT>      }<a name="line.399"></a>
<FONT color="green">400</FONT>      <a name="line.400"></a>
<FONT color="green">401</FONT>      /**<a name="line.401"></a>
<FONT color="green">402</FONT>       * A rank function using delta as ranking criteria.<a name="line.402"></a>
<FONT color="green">403</FONT>       * <a name="line.403"></a>
<FONT color="green">404</FONT>       * @author (Cedric) Qin ZHANG<a name="line.404"></a>
<FONT color="green">405</FONT>       */<a name="line.405"></a>
<FONT color="green">406</FONT>      static class DeltaRankFunction implements RankFunction {<a name="line.406"></a>
<FONT color="green">407</FONT>        <a name="line.407"></a>
<FONT color="green">408</FONT>        /**<a name="line.408"></a>
<FONT color="green">409</FONT>         * Computes the sum of delta of a telemetry stream.<a name="line.409"></a>
<FONT color="green">410</FONT>         * @param stream A telemetry stream.<a name="line.410"></a>
<FONT color="green">411</FONT>         * @return The delta sum.<a name="line.411"></a>
<FONT color="green">412</FONT>         */<a name="line.412"></a>
<FONT color="green">413</FONT>        public double getRank(TelemetryStream stream) {<a name="line.413"></a>
<FONT color="green">414</FONT>          double sum = 0;<a name="line.414"></a>
<FONT color="green">415</FONT>          double lastValue = Double.NaN;<a name="line.415"></a>
<FONT color="green">416</FONT>          for (TelemetryDataPoint dp : stream.getDataPoints()) {<a name="line.416"></a>
<FONT color="green">417</FONT>            Number number = dp.getValue();<a name="line.417"></a>
<FONT color="green">418</FONT>            if (number != null) {<a name="line.418"></a>
<FONT color="green">419</FONT>              double numberValue = number.doubleValue();<a name="line.419"></a>
<FONT color="green">420</FONT>              if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.420"></a>
<FONT color="green">421</FONT>                if (! Double.isNaN(lastValue)) {<a name="line.421"></a>
<FONT color="green">422</FONT>                  sum += Math.abs(numberValue - lastValue);<a name="line.422"></a>
<FONT color="green">423</FONT>                }<a name="line.423"></a>
<FONT color="green">424</FONT>                lastValue = numberValue;<a name="line.424"></a>
<FONT color="green">425</FONT>              }<a name="line.425"></a>
<FONT color="green">426</FONT>            }<a name="line.426"></a>
<FONT color="green">427</FONT>          }<a name="line.427"></a>
<FONT color="green">428</FONT>          return sum;<a name="line.428"></a>
<FONT color="green">429</FONT>        }<a name="line.429"></a>
<FONT color="green">430</FONT>      }<a name="line.430"></a>
<FONT color="green">431</FONT>      <a name="line.431"></a>
<FONT color="green">432</FONT>      /**<a name="line.432"></a>
<FONT color="green">433</FONT>       * A rank function using the different between the last data point and the first data point<a name="line.433"></a>
<FONT color="green">434</FONT>       * as criteria. Note that this rank value may be negative if the last <a name="line.434"></a>
<FONT color="green">435</FONT>       * <a name="line.435"></a>
<FONT color="green">436</FONT>       * @author (Cedric) Qin ZHANG<a name="line.436"></a>
<FONT color="green">437</FONT>       */<a name="line.437"></a>
<FONT color="green">438</FONT>      static class SimpleDeltaRankFunction implements RankFunction {<a name="line.438"></a>
<FONT color="green">439</FONT>        <a name="line.439"></a>
<FONT color="green">440</FONT>        /**<a name="line.440"></a>
<FONT color="green">441</FONT>         * Computes the sum of delta of a telemetry stream.<a name="line.441"></a>
<FONT color="green">442</FONT>         * @param stream A telemetry stream.<a name="line.442"></a>
<FONT color="green">443</FONT>         * @return The delta sum.<a name="line.443"></a>
<FONT color="green">444</FONT>         */<a name="line.444"></a>
<FONT color="green">445</FONT>        public double getRank(TelemetryStream stream) {<a name="line.445"></a>
<FONT color="green">446</FONT>          double firstValue = Double.NaN;<a name="line.446"></a>
<FONT color="green">447</FONT>          double lastValue = Double.NaN;<a name="line.447"></a>
<FONT color="green">448</FONT>          for (TelemetryDataPoint dp : stream.getDataPoints()) {<a name="line.448"></a>
<FONT color="green">449</FONT>            Number number = dp.getValue();<a name="line.449"></a>
<FONT color="green">450</FONT>            if (number != null) {<a name="line.450"></a>
<FONT color="green">451</FONT>              double numberValue = number.doubleValue();<a name="line.451"></a>
<FONT color="green">452</FONT>              if (! Double.isInfinite(numberValue) &amp;&amp; ! Double.isNaN(numberValue)) {<a name="line.452"></a>
<FONT color="green">453</FONT>                if (Double.isNaN(firstValue)) {<a name="line.453"></a>
<FONT color="green">454</FONT>                  firstValue = numberValue;<a name="line.454"></a>
<FONT color="green">455</FONT>                }<a name="line.455"></a>
<FONT color="green">456</FONT>                lastValue = numberValue;<a name="line.456"></a>
<FONT color="green">457</FONT>              }<a name="line.457"></a>
<FONT color="green">458</FONT>            }<a name="line.458"></a>
<FONT color="green">459</FONT>          }<a name="line.459"></a>
<FONT color="green">460</FONT>          return (Double.isNaN(firstValue) || Double.isNaN(lastValue)) ? 0 : lastValue - firstValue;<a name="line.460"></a>
<FONT color="green">461</FONT>        }<a name="line.461"></a>
<FONT color="green">462</FONT>      }<a name="line.462"></a>
<FONT color="green">463</FONT>    }<a name="line.463"></a>




























































</PRE>
</BODY>
</HTML>
